Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(user feedback): display a button in a window that presents a vc #4364

Open
wants to merge 37 commits into
base: main
Choose a base branch
from

Conversation

armcknight
Copy link
Member

@armcknight armcknight commented Sep 24, 2024

#skip-changelog; for #4270

Deliver a complete styled button like we have in the javascript SDK docs that opens a modal view where the form will go in a subsequent PR.
image

Check the linked issue for updates on what it looks like with various config settings and device settings like for accessibility and dark mode.

@brustolin

This comment was marked as outdated.

@brustolin
Copy link
Contributor

brustolin commented Sep 24, 2024

h: We can debate it later, but currently we're organising Swift code under Swift folder, so

This Should be here
Screenshot 2024-09-24 at 09 28 55 Screenshot 2024-09-24 at 09 29 06

You can keep the Obj-C integration here, but the file itself is in the wrong directory. The header should be in the include path, and the .m file in the Sentry folder. This organization relates to how we distribute via CocoaPods and, in the future, SPM, when we move back to sharing code instead of a pre-compiled framework.

Edit: I realized these files were included in a previous PR. We can either fix it in this one or in another one.

@armcknight

This comment was marked as resolved.

@brustolin

This comment was marked as outdated.

@armcknight

This comment was marked as outdated.

@brustolin

This comment was marked as outdated.

This comment was marked as off-topic.

This comment was marked as off-topic.

@armcknight
Copy link
Member Author

The diff is currently a little over 500 lines added, note that half of that is just the UIBezier drawing the megaphone that I got from our SVG design asset :D

@armcknight armcknight marked this pull request as ready for review October 15, 2024 22:14

This comment was marked as off-topic.

@brustolin

This comment was marked as resolved.

brustolin

This comment was marked as resolved.

brustolin

This comment was marked as resolved.

Copy link
Contributor

@brustolin brustolin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a suggestion for the megaphone drawing

@armcknight

This comment was marked as outdated.

@armcknight
Copy link
Member Author

I think configureTheme, should be inside configureWidget, or at least the properties that configure the widget, it took me an extra second to find this out, when it would be much easier to set the widget theme inside the configureWidget callback

This can be debated separately from this PR if people want to. I'll just note here that theme options will also be needed in the form, so I tried creating a composition hierarchy that indicates they are used by more than just the widget (button):
Screenshot 2024-10-16 at 11 07 56 AM

Since the widget and form will use a lot of the same options I don't think it makes sense to make separate theme objects for each to own separately.

@armcknight
Copy link
Member Author

armcknight commented Oct 16, 2024

This need to be addressed before merging the PR.

@brustolin Would you mind if we do it in a separate PR along with #4364 (comment)? I just don't want to mess the diff up here. Nothing is being shipped yet so there's no danger of a file not being delivered where it should be.

ETA: unless it's required for CI to pass anyways, that is...
ETA2: doesn't seem so, so i'd prefer to defer this

@brustolin
Copy link
Contributor

@brustolin Would you mind if we do it in a separate PR along with #4364 (comment)? I just don't want to mess the diff up here. Nothing is being shipped yet so there's no danger of a file not being delivered where it should be.

Are you planning to merge this PR back to main without the form ready? If we make another release in the meantime, users will be able to show the button but it won't be working? What is the release plan/timeline for this?

I would happily agree to have a feature branch where we can merge this and any other partial work of user feedback.

@armcknight
Copy link
Member Author

@brustolin Would you mind if we do it in a separate PR along with #4364 (comment)? I just don't want to mess the diff up here. Nothing is being shipped yet so there's no danger of a file not being delivered where it should be.

Are you planning to merge this PR back to main without the form ready? If we make another release in the meantime, users will be able to show the button but it won't be working? What is the release plan/timeline for this?

I would happily agree to have a feature branch where we can merge this and any other partial work of user feedback.

@brustolin yes, then plan is to merge to main for each PR. The option is currently in SentryOptions+Private so they should not be able to get a widget showing in their app.

@brustolin
Copy link
Contributor

@brustolin yes, then plan is to merge to main for each PR. The option is currently in SentryOptions+Private so they should not be able to get a widget showing in their app.

Ok, good enough for me. Thanks!

Copy link
Contributor

@brustolin brustolin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have my reservations about the composition of theme configuration, but this is not a blocker.

LGTM

Comment on lines +42 to +43
NSMutableArray<NSString *> *
sentry_defaultIntegrations(void)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Why was this changed?
Just curious.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to return a mutable array so that I can conditionally add the user feedback integration before installing all integrations, if the options property to configure its options is set (which implicitly enables the feature)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants